} else {
$this->prop = array();
}
- $r['currentuser'] = $this->getCurrentUserInfo();
-
- if(is_array($params['users'])) {
- $r['users'] = $this->getOtherUsersInfo($params['users']);
- $result->setIndexedTagName($r['users'], 'user');
- }
+ $r = $this->getCurrentUserInfo();
$result->addValue("query", $this->getModuleName(), $r);
}
- protected function getOtherUsersInfo($users) {
- $goodNames = $retval = array();
- // Canonicalize user names
- foreach($users as $u) {
- $n = User::getCanonicalName($u);
- if($n === false)
- $retval[] = array('name' => $u, 'invalid' => '');
- else
- $goodNames[] = $n;
- }
-
- $db = $this->getDb();
- $userTable = $db->tableName('user');
- $tables = "$userTable AS u1";
- $this->addFields('u1.user_name');
- $this->addWhereFld('u1.user_name', $goodNames);
- $this->addFieldsIf('u1.user_editcount', isset($this->prop['editcount']));
-
- if(isset($this->prop['groups'])) {
- $ug = $db->tableName('user_groups');
- $tables = "$tables LEFT JOIN $ug ON ug_user=u1.user_id";
- $this->addFields('ug_group');
- }
- if(isset($this->prop['blockinfo'])) {
- $ipb = $db->tableName('ipblocks');
- $tables = "$tables LEFT JOIN $ipb ON ipb_user=u1.user_id";
- $tables = "$tables LEFT JOIN $userTable AS u2 ON ipb_by=u2.user_id";
- $this->addFields(array('ipb_reason', 'u2.user_name AS blocker_name'));
- }
- $this->addTables($tables);
-
- $data = array();
- $res = $this->select(__METHOD__);
- while(($r = $db->fetchObject($res))) {
- $data[$r->user_name]['name'] = $r->user_name;
- if(isset($this->prop['editcount']))
- $data[$r->user_name]['editcount'] = $r->user_editcount;
- if(isset($this->prop['groups']))
- // This row contains only one group, others will be added from other rows
- if(!is_null($r->ug_group))
- $data[$r->user_name]['groups'][] = $r->ug_group;
- if(isset($this->prop['blockinfo']))
- if(!is_null($r->blocker_name)) {
- $data[$r->user_name]['blockedby'] = $r->blocker_name;
- $data[$r->user_name]['blockreason'] = $r->ipb_reason;
- }
- }
-
- // Second pass: add result data to $retval
- foreach($goodNames as $u) {
- if(!isset($data[$u]))
- $retval[] = array('name' => $u, 'missing' => '');
- else {
- if(isset($this->prop['groups']) && isset($data[$u]['groups']))
- $this->getResult()->setIndexedTagName($data[$u]['groups'], 'g');
- $retval[] = $data[$u];
- }
- }
- return $retval;
- }
-
protected function getCurrentUserInfo() {
global $wgUser;
$result = $this->getResult();
'prop' => array(
'What pieces of information to include',
' blockinfo - tags if the user is blocked, by whom, and for what reason',
- ' hasmsg - adds a tag "message" if user has pending messages (current user only)',
+ ' hasmsg - adds a tag "message" if user has pending messages',
' groups - lists all the groups the user belongs to',
- ' rights - lists of all rights the user has (current user only)',
- ' options - lists all preferences the user has set (current user only)',
+ ' rights - lists of all rights the user has',
+ ' options - lists all preferences the user has set',
' editcount - adds the user\'s edit count'
),
'users' => 'A list of other users to obtain the same information for'
}
protected function getDescription() {
- return 'Get information about the current user and other users';
+ return 'Get information about the current user';
}
protected function getExamples() {
--- /dev/null
+<?php\r
+\r
+/*\r
+ * Created on July 30, 2007\r
+ *\r
+ * API for MediaWiki 1.8+\r
+ *\r
+ * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl\r
+ *\r
+ * This program is free software; you can redistribute it and/or modify\r
+ * it under the terms of the GNU General Public License as published by\r
+ * the Free Software Foundation; either version 2 of the License, or\r
+ * (at your option) any later version.\r
+ *\r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License along\r
+ * with this program; if not, write to the Free Software Foundation, Inc.,\r
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
+ * http://www.gnu.org/copyleft/gpl.html\r
+ */\r
+\r
+if (!defined('MEDIAWIKI')) {\r
+ // Eclipse helper - will be ignored in production\r
+ require_once ('ApiQueryBase.php');\r
+}\r
+\r
+/**\r
+ * Query module to get information about a list of users\r
+ * \r
+ * @addtogroup API\r
+ */\r
+ \r
+ class ApiQueryUsers extends ApiQueryBase {\r
+\r
+ public function __construct($query, $moduleName) {\r
+ parent :: __construct($query, $moduleName, 'us');\r
+ }\r
+\r
+ public function execute() {\r
+ $params = $this->extractRequestParams();\r
+ $result = $this->getResult();\r
+ $r = array();\r
+\r
+ if (!is_null($params['prop'])) {\r
+ $this->prop = array_flip($params['prop']);\r
+ } else {\r
+ $this->prop = array();\r
+ }\r
+ \r
+ if(is_array($params['users'])) {\r
+ $r = $this->getOtherUsersInfo($params['users']);\r
+ $result->setIndexedTagName($r, 'user');\r
+ }\r
+ $result->addValue("query", $this->getModuleName(), $r);\r
+ }\r
+\r
+ protected function getOtherUsersInfo($users) {\r
+ $goodNames = $retval = array();\r
+ // Canonicalize user names\r
+ foreach($users as $u) {\r
+ $n = User::getCanonicalName($u);\r
+ if($n === false) \r
+ $retval[] = array('name' => $u, 'invalid' => '');\r
+ else\r
+ $goodNames[] = $n;\r
+ }\r
+\r
+ $db = $this->getDb();\r
+ $userTable = $db->tableName('user');\r
+ $tables = "$userTable AS u1";\r
+ $this->addFields('u1.user_name');\r
+ $this->addWhereFld('u1.user_name', $goodNames);\r
+ $this->addFieldsIf('u1.user_editcount', isset($this->prop['editcount']));\r
+ \r
+ if(isset($this->prop['groups'])) {\r
+ $ug = $db->tableName('user_groups');\r
+ $tables = "$tables LEFT JOIN $ug ON ug_user=u1.user_id";\r
+ $this->addFields('ug_group');\r
+ }\r
+ if(isset($this->prop['blockinfo'])) {\r
+ $ipb = $db->tableName('ipblocks');\r
+ $tables = "$tables LEFT JOIN $ipb ON ipb_user=u1.user_id";\r
+ $tables = "$tables LEFT JOIN $userTable AS u2 ON ipb_by=u2.user_id";\r
+ $this->addFields(array('ipb_reason', 'u2.user_name AS blocker_name'));\r
+ }\r
+ $this->addTables($tables);\r
+ \r
+ $data = array();\r
+ $res = $this->select(__METHOD__);\r
+ while(($r = $db->fetchObject($res))) {\r
+ $data[$r->user_name]['name'] = $r->user_name;\r
+ if(isset($this->prop['editcount']))\r
+ $data[$r->user_name]['editcount'] = $r->user_editcount;\r
+ if(isset($this->prop['groups']))\r
+ // This row contains only one group, others will be added from other rows\r
+ if(!is_null($r->ug_group))\r
+ $data[$r->user_name]['groups'][] = $r->ug_group;\r
+ if(isset($this->prop['blockinfo']))\r
+ if(!is_null($r->blocker_name)) {\r
+ $data[$r->user_name]['blockedby'] = $r->blocker_name;\r
+ $data[$r->user_name]['blockreason'] = $r->ipb_reason;\r
+ }\r
+ }\r
+ \r
+ // Second pass: add result data to $retval\r
+ foreach($goodNames as $u) {\r
+ if(!isset($data[$u]))\r
+ $retval[] = array('name' => $u, 'missing' => '');\r
+ else {\r
+ if(isset($this->prop['groups']) && isset($data[$u]['groups']))\r
+ $this->getResult()->setIndexedTagName($data[$u]['groups'], 'g');\r
+ $retval[] = $data[$u];\r
+ }\r
+ }\r
+ return $retval; \r
+ }\r
+\r
+ protected function getAllowedParams() {\r
+ return array (\r
+ 'prop' => array (\r
+ ApiBase :: PARAM_DFLT => NULL,\r
+ ApiBase :: PARAM_ISMULTI => true,\r
+ ApiBase :: PARAM_TYPE => array (\r
+ 'blockinfo',\r
+ 'groups',\r
+ 'editcount'\r
+ )\r
+ ),\r
+ 'users' => array(\r
+ ApiBase :: PARAM_ISMULTI => true\r
+ )\r
+ );\r
+ }\r
+\r
+ protected function getParamDescription() {\r
+ return array (\r
+ 'prop' => array(\r
+ 'What pieces of information to include',\r
+ ' blockinfo - tags if the user is blocked, by whom, and for what reason',\r
+ ' groups - lists all the groups the user belongs to',\r
+ ' editcount - adds the user\'s edit count'\r
+ ),\r
+ 'users' => 'A list of users to obtain the same information for'\r
+ );\r
+ }\r
+\r
+ protected function getDescription() {\r
+ return 'Get information about a list of users';\r
+ }\r
+\r
+ protected function getExamples() {\r
+ return 'api.php?action=query&list=users&ususers=brion|TimStarling&usprop=groups|editcount';\r
+ }\r
+\r
+ public function getVersion() {\r
+ return __CLASS__ . ': $Id: ApiQueryUserInfo.php 30128 2008-01-24 17:59:07Z catrope $';\r
+ }\r
+}\r
dépôts / lhc / web / wiklou.git / commitdiff